com.vmware.vcenter.namespace_management.networks.nsx

Interface DistributedSwitches

All Superinterfaces:

DistributedSwitchesTypes, Service

All Known Implementing Classes:

DistributedSwitchesStub

public interface DistributedSwitches
extends Service, DistributedSwitchesTypes

The DistributedSwitches interface provides methods to get the basic information of Distributed Switches. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.networks.nsx.DistributedSwitchesTypes

DistributedSwitchesTypes.FilterSpec, DistributedSwitchesTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.networks.nsx.DistributedSwitchesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<DistributedSwitchesTypes.Summary>	list(DistributedSwitchesTypes.FilterSpec filter) Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec.
void	list(DistributedSwitchesTypes.FilterSpec filter, AsyncCallback<java.util.List<DistributedSwitchesTypes.Summary>> asyncCallback) Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec.
void	list(DistributedSwitchesTypes.FilterSpec filter, AsyncCallback<java.util.List<DistributedSwitchesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec.
java.util.List<DistributedSwitchesTypes.Summary>	list(DistributedSwitchesTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec.

Method Detail

list

java.util.List<DistributedSwitchesTypes.Summary> list(DistributedSwitchesTypes.FilterSpec filter)

Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec. This method was added in vSphere API 8.0.0.1.

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

Parameters:

filter - Specification of matching Distributed Switches for which information should be returned. If null, the behavior is equivalent to a DistributedSwitchesTypes.FilterSpec with all properties null which means all Distributed Switches will be returned.

Returns:

List of Distributed Switches summaries matching the DistributedSwitchesTypes.FilterSpec.

Throws:

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

InvalidArgument - if one or more fields of the DistributedSwitchesTypes.FilterSpec is incorrect.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

java.util.List<DistributedSwitchesTypes.Summary> list(DistributedSwitchesTypes.FilterSpec filter,
                                                      InvocationConfig invocationConfig)

Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec. This method was added in vSphere API 8.0.0.1.

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:

filter - Specification of matching Distributed Switches for which information should be returned. If null, the behavior is equivalent to a DistributedSwitchesTypes.FilterSpec with all properties null which means all Distributed Switches will be returned.

invocationConfig - Configuration for the method invocation.

Returns:

List of Distributed Switches summaries matching the DistributedSwitchesTypes.FilterSpec.

Throws:

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

InvalidArgument - if one or more fields of the DistributedSwitchesTypes.FilterSpec is incorrect.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

void list(DistributedSwitchesTypes.FilterSpec filter,
          AsyncCallback<java.util.List<DistributedSwitchesTypes.Summary>> asyncCallback)

Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
List of Distributed Switches summaries matching the DistributedSwitchesTypes.FilterSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if one or more fields of the DistributedSwitchesTypes.FilterSpec is incorrect.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

filter - Specification of matching Distributed Switches for which information should be returned. If null, the behavior is equivalent to a DistributedSwitchesTypes.FilterSpec with all properties null which means all Distributed Switches will be returned.

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

list

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

Returns basic information of the Distributed Switches matching the DistributedSwitchesTypes.FilterSpec. This method was added in vSphere API 8.0.0.1.

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:
List of Distributed Switches summaries matching the DistributedSwitchesTypes.FilterSpec.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if one or more fields of the DistributedSwitchesTypes.FilterSpec is incorrect.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

filter - Specification of matching Distributed Switches for which information should be returned. If null, the behavior is equivalent to a DistributedSwitchesTypes.FilterSpec with all properties null which means all Distributed Switches will be returned.

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

invocationConfig - Configuration for the method invocation.