com.vmware.nsx.pools

Class VniPoolsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.pools.VniPoolsStub

All Implemented Interfaces:

VniPools, VniPoolsTypes, com.vmware.vapi.bindings.Service

public class VniPoolsStub
extends com.vmware.vapi.internal.bindings.Stub
implements VniPools

Remote stub implementation of the VniPools 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.pools.VniPoolsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
VniPoolsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
VniPoolsStub(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
VniPool	create(VniPool vniPool) Creates a new VNI pool using the specified VNI pool range.
void	create(VniPool vniPool, com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback) Creates a new VNI pool using the specified VNI pool range.
void	create(VniPool vniPool, com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new VNI pool using the specified VNI pool range.
VniPool	create(VniPool vniPool, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new VNI pool using the specified VNI pool range.
void	delete(java.lang.String poolId, java.lang.Boolean force) Deletes the given VNI pool.
void	delete(java.lang.String poolId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes the given VNI pool.
void	delete(java.lang.String poolId, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the given VNI pool.
void	delete(java.lang.String poolId, java.lang.Boolean force, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the given VNI pool.
VniPool	get(java.lang.String poolId) Returns information about the specified virtual network identifier (VNI) pool.
void	get(java.lang.String poolId, com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback) Returns information about the specified virtual network identifier (VNI) pool.
void	get(java.lang.String poolId, com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the specified virtual network identifier (VNI) pool.
VniPool	get(java.lang.String poolId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the specified virtual network identifier (VNI) pool.
VniPoolListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VniPoolListResult> asyncCallback) Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<VniPoolListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments.
VniPoolListResult	list(java.lang.String cursor, 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 the default and configured virtual network identifier (VNI) pools for use when building logical network segments.
VniPool	update(java.lang.String poolId, VniPool vniPool) Updates the specified VNI pool.
void	update(java.lang.String poolId, VniPool vniPool, com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback) Updates the specified VNI pool.
void	update(java.lang.String poolId, VniPool vniPool, com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates the specified VNI pool.
VniPool	update(java.lang.String poolId, VniPool vniPool, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates the specified VNI pool.

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

VniPoolsStub

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

VniPoolsStub

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

Method Detail

create

public VniPool create(VniPool vniPool)

Description copied from interface: VniPools

Creates a new VNI pool using the specified VNI pool range. The range should be non-overlapping with an existing range. If the range in payload is present or overlaps with an existing range, return code 400 with bad request and an error message is returned mentioning that the given range overlaps with an existing range.

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

Specified by:

create in interface VniPools

Parameters:

vniPool - (required)

Returns:

com.vmware.nsx.model.VniPool

create

public VniPool create(VniPool vniPool,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VniPools

Creates a new VNI pool using the specified VNI pool range. The range should be non-overlapping with an existing range. If the range in payload is present or overlaps with an existing range, return code 400 with bad request and an error message is returned mentioning that the given range overlaps with an existing range.

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:

create in interface VniPools

Parameters:

vniPool - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VniPool

create

public void create(VniPool vniPool,
                   com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback)

Description copied from interface: VniPools

Creates a new VNI pool using the specified VNI pool range. The range should be non-overlapping with an existing range. If the range in payload is present or overlaps with an existing range, return code 400 with bad request and an error message is returned mentioning that the given range overlaps with an existing range.

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

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

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

Specified by:

create in interface VniPools

Parameters:

vniPool - (required)

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

create

public void create(VniPool vniPool,
                   com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VniPools

Creates a new VNI pool using the specified VNI pool range. The range should be non-overlapping with an existing range. If the range in payload is present or overlaps with an existing range, return code 400 with bad request and an error message is returned mentioning that the given range overlaps with an existing range.

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

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

Specified by:

create in interface VniPools

Parameters:

vniPool - (required)

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String poolId,
                   java.lang.Boolean force)

Description copied from interface: VniPools

Deletes the given VNI pool.

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

Specified by:

delete in interface VniPools

Parameters:

poolId - VNI pool id (required)

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

delete

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

Description copied from interface: VniPools

Deletes the given VNI pool.

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:

delete in interface VniPools

Parameters:

poolId - VNI pool id (required)

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

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: VniPools

Deletes the given VNI pool.

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:

delete in interface VniPools

Parameters:

poolId - VNI pool id (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

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

Description copied from interface: VniPools

Deletes the given VNI pool.

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:

delete in interface VniPools

Parameters:

poolId - VNI pool id (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

public VniPool get(java.lang.String poolId)

Description copied from interface: VniPools

Returns information about the specified virtual network identifier (VNI) pool.

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

Specified by:

get in interface VniPools

Parameters:

poolId - VNI pool ID (required)

Returns:

com.vmware.nsx.model.VniPool

get

public VniPool get(java.lang.String poolId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VniPools

Returns information about the specified virtual network identifier (VNI) pool.

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:

get in interface VniPools

Parameters:

poolId - VNI pool ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VniPool

get

public void get(java.lang.String poolId,
                com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback)

Description copied from interface: VniPools

Returns information about the specified virtual network identifier (VNI) pool.

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

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

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

Specified by:

get in interface VniPools

Parameters:

poolId - VNI pool ID (required)

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

get

public void get(java.lang.String poolId,
                com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VniPools

Returns information about the specified virtual network identifier (VNI) pool.

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

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

Specified by:

get in interface VniPools

Parameters:

poolId - VNI pool ID (required)

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

invocationConfig - Configuration for the method invocation.

list

public VniPoolListResult list(java.lang.String cursor,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy)

Description copied from interface: VniPools

Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments. Each virtual network has a unique ID called a VNI. Instead of creating a new VNI each time you need a new logical switch, you can instead allocate a VNI from a VNI pool. VNI pools are sometimes called segment ID pools. Each VNI pool has a range of usable VNIs. By default, there is one pool with two ranges [5000, 65535] and [65536, 75000]. To create multiple smaller pools, specify a smaller range for each pool such as 75001-75100 and 75101-75200. The VNI range determines the maximum number of logical switches that can be created in each network segment.

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

Specified by:

list in interface VniPools

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)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.VniPoolListResult

list

public VniPoolListResult list(java.lang.String cursor,
                              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: VniPools

Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments. Each virtual network has a unique ID called a VNI. Instead of creating a new VNI each time you need a new logical switch, you can instead allocate a VNI from a VNI pool. VNI pools are sometimes called segment ID pools. Each VNI pool has a range of usable VNIs. By default, there is one pool with two ranges [5000, 65535] and [65536, 75000]. To create multiple smaller pools, specify a smaller range for each pool such as 75001-75100 and 75101-75200. The VNI range determines the maximum number of logical switches that can be created in each network segment.

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 VniPools

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)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VniPoolListResult

list

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

Description copied from interface: VniPools

Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments. Each virtual network has a unique ID called a VNI. Instead of creating a new VNI each time you need a new logical switch, you can instead allocate a VNI from a VNI pool. VNI pools are sometimes called segment ID pools. Each VNI pool has a range of usable VNIs. By default, there is one pool with two ranges [5000, 65535] and [65536, 75000]. To create multiple smaller pools, specify a smaller range for each pool such as 75001-75100 and 75101-75200. The VNI range determines the maximum number of logical switches that can be created in each network segment.

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

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

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

Specified by:

list in interface VniPools

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)

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

Description copied from interface: VniPools

Returns information about the default and configured virtual network identifier (VNI) pools for use when building logical network segments. Each virtual network has a unique ID called a VNI. Instead of creating a new VNI each time you need a new logical switch, you can instead allocate a VNI from a VNI pool. VNI pools are sometimes called segment ID pools. Each VNI pool has a range of usable VNIs. By default, there is one pool with two ranges [5000, 65535] and [65536, 75000]. To create multiple smaller pools, specify a smaller range for each pool such as 75001-75100 and 75101-75200. The VNI range determines the maximum number of logical switches that can be created in each network segment.

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

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

Specified by:

list in interface VniPools

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)

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.

update

public VniPool update(java.lang.String poolId,
                      VniPool vniPool)

Description copied from interface: VniPools

Updates the specified VNI pool. Modifiable parameters include description, display_name and ranges. Ranges can be added, modified or deleted. Overlapping ranges are not allowed. Only range end can be modified for any existing range. Range shrinking or deletion is not allowed if there are any allocated VNIs.

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

Specified by:

update in interface VniPools

Parameters:

poolId - VNI pool ID (required)

vniPool - (required)

Returns:

com.vmware.nsx.model.VniPool

update

public VniPool update(java.lang.String poolId,
                      VniPool vniPool,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VniPools

Updates the specified VNI pool. Modifiable parameters include description, display_name and ranges. Ranges can be added, modified or deleted. Overlapping ranges are not allowed. Only range end can be modified for any existing range. Range shrinking or deletion is not allowed if there are any allocated VNIs.

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:

update in interface VniPools

Parameters:

poolId - VNI pool ID (required)

vniPool - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.VniPool

update

public void update(java.lang.String poolId,
                   VniPool vniPool,
                   com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback)

Description copied from interface: VniPools

Updates the specified VNI pool. Modifiable parameters include description, display_name and ranges. Ranges can be added, modified or deleted. Overlapping ranges are not allowed. Only range end can be modified for any existing range. Range shrinking or deletion is not allowed if there are any allocated VNIs.

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

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

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

Specified by:

update in interface VniPools

Parameters:

poolId - VNI pool ID (required)

vniPool - (required)

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

update

public void update(java.lang.String poolId,
                   VniPool vniPool,
                   com.vmware.vapi.bindings.client.AsyncCallback<VniPool> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: VniPools

Updates the specified VNI pool. Modifiable parameters include description, display_name and ranges. Ranges can be added, modified or deleted. Overlapping ranges are not allowed. Only range end can be modified for any existing range. Range shrinking or deletion is not allowed if there are any allocated VNIs.

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

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

Specified by:

update in interface VniPools

Parameters:

poolId - VNI pool ID (required)

vniPool - (required)

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

invocationConfig - Configuration for the method invocation.