com.vmware.nsx.upgrade

Class FilterUnitsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.upgrade.FilterUnitsStub

All Implemented Interfaces:

FilterUnits, FilterUnitsTypes, com.vmware.vapi.bindings.Service

public class FilterUnitsStub
extends com.vmware.vapi.internal.bindings.Stub
implements FilterUnits

Remote stub implementation of the FilterUnits 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.upgrade.FilterUnitsTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
FilterUnitsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
FilterUnitsStub(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
UpgradeUnitAggregateInfoListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.String groupName, java.lang.String hypervisor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String unitIp, java.lang.String unitName) Get all the upgrade unit groups based in the filter applied.
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.String groupName, java.lang.String hypervisor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String unitIp, java.lang.String unitName, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback) Get all the upgrade unit groups based in the filter applied.
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.String groupName, java.lang.String hypervisor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String unitIp, java.lang.String unitName, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all the upgrade unit groups based in the filter applied.
UpgradeUnitAggregateInfoListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String groupId, java.lang.String groupName, java.lang.String hypervisor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String status, java.lang.String unitIp, java.lang.String unitName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all the upgrade unit groups based in the filter applied.

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

FilterUnitsStub

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

FilterUnitsStub

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

Method Detail

list

public UpgradeUnitAggregateInfoListResult list(java.lang.String componentType,
                                               java.lang.String cursor,
                                               java.lang.String groupId,
                                               java.lang.String groupName,
                                               java.lang.String hypervisor,
                                               java.lang.String includedFields,
                                               java.lang.Long pageSize,
                                               java.lang.Boolean sortAscending,
                                               java.lang.String sortBy,
                                               java.lang.String status,
                                               java.lang.String unitIp,
                                               java.lang.String unitName)

Description copied from interface: FilterUnits

Get all the upgrade unit groups based in the filter applied. The filter can be on component type, group name, id,enabled, status, unit name, unit IP, status, Hypervisor.

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

Specified by:

list in interface FilterUnits

Parameters:

componentType - Component type based on which upgrade units to be filtered (required)

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

groupId - Identifier of group based on which upgrade units to be filtered (optional)

groupName - Group name to be filtered (optional)

hypervisor - Hypervisor to be filtered for the upgrade unit (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)

status - Status of the upgrade unit to filtered (optional)

unitIp - IP of the upgrade unit to be filtered (optional)

unitName - Unit name to be filtered for the group (optional)

Returns:

com.vmware.nsx.model.UpgradeUnitAggregateInfoListResult

list

public UpgradeUnitAggregateInfoListResult list(java.lang.String componentType,
                                               java.lang.String cursor,
                                               java.lang.String groupId,
                                               java.lang.String groupName,
                                               java.lang.String hypervisor,
                                               java.lang.String includedFields,
                                               java.lang.Long pageSize,
                                               java.lang.Boolean sortAscending,
                                               java.lang.String sortBy,
                                               java.lang.String status,
                                               java.lang.String unitIp,
                                               java.lang.String unitName,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: FilterUnits

Get all the upgrade unit groups based in the filter applied. The filter can be on component type, group name, id,enabled, status, unit name, unit IP, status, Hypervisor.

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 FilterUnits

Parameters:

componentType - Component type based on which upgrade units to be filtered (required)

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

groupId - Identifier of group based on which upgrade units to be filtered (optional)

groupName - Group name to be filtered (optional)

hypervisor - Hypervisor to be filtered for the upgrade unit (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)

status - Status of the upgrade unit to filtered (optional)

unitIp - IP of the upgrade unit to be filtered (optional)

unitName - Unit name to be filtered for the group (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeUnitAggregateInfoListResult

list

public void list(java.lang.String componentType,
                 java.lang.String cursor,
                 java.lang.String groupId,
                 java.lang.String groupName,
                 java.lang.String hypervisor,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String status,
                 java.lang.String unitIp,
                 java.lang.String unitName,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback)

Description copied from interface: FilterUnits

Get all the upgrade unit groups based in the filter applied. The filter can be on component type, group name, id,enabled, status, unit name, unit IP, status, Hypervisor.

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

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

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

Specified by:

list in interface FilterUnits

Parameters:

componentType - Component type based on which upgrade units to be filtered (required)

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

groupId - Identifier of group based on which upgrade units to be filtered (optional)

groupName - Group name to be filtered (optional)

hypervisor - Hypervisor to be filtered for the upgrade unit (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)

status - Status of the upgrade unit to filtered (optional)

unitIp - IP of the upgrade unit to be filtered (optional)

unitName - Unit name to be filtered for the group (optional)

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

list

public void list(java.lang.String componentType,
                 java.lang.String cursor,
                 java.lang.String groupId,
                 java.lang.String groupName,
                 java.lang.String hypervisor,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String status,
                 java.lang.String unitIp,
                 java.lang.String unitName,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeUnitAggregateInfoListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: FilterUnits

Get all the upgrade unit groups based in the filter applied. The filter can be on component type, group name, id,enabled, status, unit name, unit IP, status, Hypervisor.

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

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

Specified by:

list in interface FilterUnits

Parameters:

componentType - Component type based on which upgrade units to be filtered (required)

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

groupId - Identifier of group based on which upgrade units to be filtered (optional)

groupName - Group name to be filtered (optional)

hypervisor - Hypervisor to be filtered for the upgrade unit (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)

status - Status of the upgrade unit to filtered (optional)

unitIp - IP of the upgrade unit to be filtered (optional)

unitName - Unit name to be filtered for the group (optional)

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

invocationConfig - Configuration for the method invocation.