Package com.vmware.nsx_policy.infra.dhcp_server_configs

Class LeasesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.infra.dhcp_server_configs.LeasesStub

All Implemented Interfaces:

Leases, LeasesTypes, com.vmware.vapi.bindings.Service

public class LeasesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Leases

Remote stub implementation of the Leases 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_policy.infra.dhcp_server_configs.LeasesTypes

_VAPI_SERVICE_ID, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Constructor Summary

Constructors

Constructor	Description
LeasesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
LeasesStub(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	Description
DhcpLeasesResult	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source)	Read DHCP server leases
void	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback)	Read DHCP server leases
void	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read DHCP server leases
DhcpLeasesResult	list(java.lang.String configId, java.lang.String connectivityPath, java.lang.String address, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentPath, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read DHCP server leases

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

LeasesStub

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

LeasesStub

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

Method Detail

list

public DhcpLeasesResult list(java.lang.String configId,
                             java.lang.String connectivityPath,
                             java.lang.String address,
                             java.lang.String cursor,
                             java.lang.String enforcementPointPath,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.String segmentPath,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             java.lang.String source)

Description copied from interface: Leases

Read DHCP server leases

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

Specified by:

list in interface Leases

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

Returns:

com.vmware.nsx_policy.model.DhcpLeasesResult

list

public DhcpLeasesResult list(java.lang.String configId,
                             java.lang.String connectivityPath,
                             java.lang.String address,
                             java.lang.String cursor,
                             java.lang.String enforcementPointPath,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.String segmentPath,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             java.lang.String source,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Leases

Read DHCP server leases

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 Leases

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.DhcpLeasesResult

list

public void list(java.lang.String configId,
                 java.lang.String connectivityPath,
                 java.lang.String address,
                 java.lang.String cursor,
                 java.lang.String enforcementPointPath,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.String segmentPath,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback)

Description copied from interface: Leases

Read DHCP server leases

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

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

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

Specified by:

list in interface Leases

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

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

list

public void list(java.lang.String configId,
                 java.lang.String connectivityPath,
                 java.lang.String address,
                 java.lang.String cursor,
                 java.lang.String enforcementPointPath,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.String segmentPath,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<DhcpLeasesResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Leases

Read DHCP server leases

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

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

Specified by:

list in interface Leases

Parameters:

configId - (required)

connectivityPath - String Path of Tier0, Tier1 or Segment (required)

address - IP or MAC address (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

segmentPath - Segment path to retrieve lease information (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.