com.vmware.nsx.pools

Class IpSubnetsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.pools.IpSubnetsStub

All Implemented Interfaces:

IpSubnets, IpSubnetsTypes, com.vmware.vapi.bindings.Service

public class IpSubnetsStub
extends com.vmware.vapi.internal.bindings.Stub
implements IpSubnets

Remote stub implementation of the IpSubnets 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.IpSubnetsTypes

_VAPI_SERVICE_ID, ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_ALLOCATE, ALLOCATEORRELEASEFROMIPBLOCKSUBNET_ACTION_RELEASE

Constructor Summary

Constructors

Constructor and Description
IpSubnetsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
IpSubnetsStub(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
AllocationIpAddress	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action) Synchronous method overload.
void	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback) Asynchronous method overload.
void	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
AllocationIpAddress	allocateorreleasefromipblocksubnet(java.lang.String subnetId, AllocationIpAddress allocationIpAddress, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
IpBlockSubnet	create(IpBlockSubnet ipBlockSubnet) Synchronous method overload.
void	create(IpBlockSubnet ipBlockSubnet, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback) Asynchronous method overload.
void	create(IpBlockSubnet ipBlockSubnet, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
IpBlockSubnet	create(IpBlockSubnet ipBlockSubnet, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
void	delete(java.lang.String subnetId) Synchronous method overload.
void	delete(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Asynchronous method overload.
void	delete(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
void	delete(java.lang.String subnetId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
IpBlockSubnet	get(java.lang.String subnetId) Synchronous method overload.
void	get(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback) Asynchronous method overload.
void	get(java.lang.String subnetId, com.vmware.vapi.bindings.client.AsyncCallback<IpBlockSubnet> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
IpBlockSubnet	get(java.lang.String subnetId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
IpBlockSubnetListResult	list(java.lang.String blockId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all subnets present within an IP address block.
void	list(java.lang.String blockId, 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<IpBlockSubnetListResult> asyncCallback) Returns information about all subnets present within an IP address block.
void	list(java.lang.String blockId, 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<IpBlockSubnetListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all subnets present within an IP address block.
IpBlockSubnetListResult	list(java.lang.String blockId, 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 all subnets present within an IP address block.

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

IpSubnetsStub

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

IpSubnetsStub

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

Method Detail

allocateorreleasefromipblocksubnet

public AllocationIpAddress allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                                              AllocationIpAddress allocationIpAddress,
                                                              java.lang.String action)

Description copied from interface: IpSubnets

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

Specified by:

allocateorreleasefromipblocksubnet in interface IpSubnets

Parameters:

subnetId - IP subnet id (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

Returns:

com.vmware.nsx.model.AllocationIpAddress

allocateorreleasefromipblocksubnet

public AllocationIpAddress allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                                              AllocationIpAddress allocationIpAddress,
                                                              java.lang.String action,
                                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: IpSubnets

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:

allocateorreleasefromipblocksubnet in interface IpSubnets

Parameters:

subnetId - IP subnet id (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.AllocationIpAddress

allocateorreleasefromipblocksubnet

public void allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                               AllocationIpAddress allocationIpAddress,
                                               java.lang.String action,
                                               com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback)

Description copied from interface: IpSubnets

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

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

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

Specified by:

allocateorreleasefromipblocksubnet in interface IpSubnets

Parameters:

subnetId - IP subnet id (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

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

allocateorreleasefromipblocksubnet

public void allocateorreleasefromipblocksubnet(java.lang.String subnetId,
                                               AllocationIpAddress allocationIpAddress,
                                               java.lang.String action,
                                               com.vmware.vapi.bindings.client.AsyncCallback<AllocationIpAddress> asyncCallback,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: IpSubnets

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

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

Specified by:

allocateorreleasefromipblocksubnet in interface IpSubnets

Parameters:

subnetId - IP subnet id (required)

allocationIpAddress - (required)

action - Specifies allocate or release action (required)

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

invocationConfig - Configuration for the method invocation.

create

public IpBlockSubnet create(IpBlockSubnet ipBlockSubnet)

Description copied from interface: IpSubnets

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

Specified by:

create in interface IpSubnets

Parameters:

ipBlockSubnet - (required)

Returns:

com.vmware.nsx.model.IpBlockSubnet

create

public IpBlockSubnet create(IpBlockSubnet ipBlockSubnet,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: IpSubnets

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 IpSubnets

Parameters:

ipBlockSubnet - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpBlockSubnet

create

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

Description copied from interface: IpSubnets

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

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

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

Specified by:

create in interface IpSubnets

Parameters:

ipBlockSubnet - (required)

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

create

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

Description copied from interface: IpSubnets

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

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

Specified by:

create in interface IpSubnets

Parameters:

ipBlockSubnet - (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 subnetId)

Description copied from interface: IpSubnets

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

Specified by:

delete in interface IpSubnets

Parameters:

subnetId - Subnet id (required)

delete

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

Description copied from interface: IpSubnets

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 IpSubnets

Parameters:

subnetId - Subnet id (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: IpSubnets

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 IpSubnets

Parameters:

subnetId - Subnet id (required)

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

delete

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

Description copied from interface: IpSubnets

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 IpSubnets

Parameters:

subnetId - Subnet id (required)

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

invocationConfig - Configuration for the method invocation.

get

public IpBlockSubnet get(java.lang.String subnetId)

Description copied from interface: IpSubnets

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

Specified by:

get in interface IpSubnets

Parameters:

subnetId - Subnet id (required)

Returns:

com.vmware.nsx.model.IpBlockSubnet

get

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

Description copied from interface: IpSubnets

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 IpSubnets

Parameters:

subnetId - Subnet id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IpBlockSubnet

get

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

Description copied from interface: IpSubnets

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

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

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

Specified by:

get in interface IpSubnets

Parameters:

subnetId - Subnet id (required)

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

get

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

Description copied from interface: IpSubnets

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

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

Specified by:

get in interface IpSubnets

Parameters:

subnetId - Subnet id (required)

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

invocationConfig - Configuration for the method invocation.

list

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

Description copied from interface: IpSubnets

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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

Specified by:

list in interface IpSubnets

Parameters:

blockId - (optional)

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

list

public IpBlockSubnetListResult list(java.lang.String blockId,
                                    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: IpSubnets

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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 IpSubnets

Parameters:

blockId - (optional)

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

list

public void list(java.lang.String blockId,
                 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<IpBlockSubnetListResult> asyncCallback)

Description copied from interface: IpSubnets

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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

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

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

Specified by:

list in interface IpSubnets

Parameters:

blockId - (optional)

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 blockId,
                 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<IpBlockSubnetListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: IpSubnets

Returns information about all subnets present within an IP address block. Information includes subnet's id, display_name, description, cidr and allocation ranges.

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

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

Specified by:

list in interface IpSubnets

Parameters:

blockId - (optional)

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.