public interface Edges extends Service, EdgesTypes
Edges
interface provides methods to retrieve the basic information
for NSX Edges. This interface was added in vSphere API 8.0.0.1.EdgesTypes.FilterSpec, EdgesTypes.Summary
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
java.util.List<EdgesTypes.Summary> |
list(EdgesTypes.FilterSpec filter)
Returns a list of Edges matching the given filter.
|
void |
list(EdgesTypes.FilterSpec filter,
AsyncCallback<java.util.List<EdgesTypes.Summary>> asyncCallback)
Returns a list of Edges matching the given filter.
|
void |
list(EdgesTypes.FilterSpec filter,
AsyncCallback<java.util.List<EdgesTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
Returns a list of Edges matching the given filter.
|
java.util.List<EdgesTypes.Summary> |
list(EdgesTypes.FilterSpec filter,
InvocationConfig invocationConfig)
Returns a list of Edges matching the given filter.
|
java.util.List<EdgesTypes.Summary> list(EdgesTypes.FilterSpec filter)
Synchronous method overload. Result of the invocation will be reported as a method return value.
filter
- Specification of matching Edges for which information should be returned.
If null
, the behavior is equivalent to a EdgesTypes.FilterSpec
with
all properties null
which means all Edges will be returned.Error
- if the system reports an error while responding to the request.InvalidArgument
- if one or more fields of the EdgesTypes.FilterSpec
is
incorrect.Unauthenticated
- if the user cannot be authenticated.Unauthorized
- if the user does not have System.Read
privilege.java.util.List<EdgesTypes.Summary> list(EdgesTypes.FilterSpec filter, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
filter
- Specification of matching Edges for which information should be returned.
If null
, the behavior is equivalent to a EdgesTypes.FilterSpec
with
all properties null
which means all Edges will be returned.invocationConfig
- Configuration for the method invocation.Error
- if the system reports an error while responding to the request.InvalidArgument
- if one or more fields of the EdgesTypes.FilterSpec
is
incorrect.Unauthenticated
- if the user cannot be authenticated.Unauthorized
- if the user does not have System.Read
privilege.void list(EdgesTypes.FilterSpec filter, AsyncCallback<java.util.List<EdgesTypes.Summary>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
List of Edge summaries matching the given filter.
Operation Errors:
Error
- if the system reports an error while responding to the request.
InvalidArgument
- if one or more fields of the EdgesTypes.FilterSpec
is
incorrect.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user does not have System.Read
privilege.
filter
- Specification of matching Edges for which information should be returned.
If null
, the behavior is equivalent to a EdgesTypes.FilterSpec
with
all properties null
which means all Edges will be returned.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(EdgesTypes.FilterSpec filter, AsyncCallback<java.util.List<EdgesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
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 Edge summaries matching the given filter.
Operation Errors:
Error
- if the system reports an error while responding to the request.
InvalidArgument
- if one or more fields of the EdgesTypes.FilterSpec
is
incorrect.
Unauthenticated
- if the user cannot be authenticated.
Unauthorized
- if the user does not have System.Read
privilege.
filter
- Specification of matching Edges for which information should be returned.
If null
, the behavior is equivalent to a EdgesTypes.FilterSpec
with
all properties null
which means all Edges will be returned.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.