com.vmware.nsx.upgrade

Interface FilterGroups

All Superinterfaces:

FilterGroupsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

FilterGroupsStub

public interface FilterGroups
extends com.vmware.vapi.bindings.Service, FilterGroupsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.upgrade.FilterGroupsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
UpgradeUnitGroupAggregateInfoListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String enabled, java.lang.String groupId, java.lang.String groupName, 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 enabled, java.lang.String groupId, java.lang.String groupName, 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<UpgradeUnitGroupAggregateInfoListResult> 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 enabled, java.lang.String groupId, java.lang.String groupName, 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<UpgradeUnitGroupAggregateInfoListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get all the upgrade unit groups based in the filter applied.
UpgradeUnitGroupAggregateInfoListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String enabled, java.lang.String groupId, java.lang.String groupName, 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.

Method Detail

list

UpgradeUnitGroupAggregateInfoListResult list(java.lang.String componentType,
                                             java.lang.String cursor,
                                             java.lang.String enabled,
                                             java.lang.String groupId,
                                             java.lang.String groupName,
                                             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. The filter can be on component type, group name, id,enabled, status, unit name, unit IP.

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

Parameters:

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

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

enabled - Status of the group to apply filter (optional)

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

groupName - Group name to be filtered (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 group to apply filter (optional)

unitIp - IP of upgrade units to be filtered (optional)

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

Returns:

com.vmware.nsx.model.UpgradeUnitGroupAggregateInfoListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

UpgradeUnitGroupAggregateInfoListResult list(java.lang.String componentType,
                                             java.lang.String cursor,
                                             java.lang.String enabled,
                                             java.lang.String groupId,
                                             java.lang.String groupName,
                                             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. The filter can be on component type, group name, id,enabled, status, unit name, unit IP.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

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

enabled - Status of the group to apply filter (optional)

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

groupName - Group name to be filtered (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 group to apply filter (optional)

unitIp - IP of upgrade units 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.UpgradeUnitGroupAggregateInfoListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

void list(java.lang.String componentType,
          java.lang.String cursor,
          java.lang.String enabled,
          java.lang.String groupId,
          java.lang.String groupName,
          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<UpgradeUnitGroupAggregateInfoListResult> asyncCallback)

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.

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

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

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

Parameters:

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

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

enabled - Status of the group to apply filter (optional)

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

groupName - Group name to be filtered (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 group to apply filter (optional)

unitIp - IP of upgrade units 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

void list(java.lang.String componentType,
          java.lang.String cursor,
          java.lang.String enabled,
          java.lang.String groupId,
          java.lang.String groupName,
          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<UpgradeUnitGroupAggregateInfoListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

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

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

Parameters:

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

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

enabled - Status of the group to apply filter (optional)

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

groupName - Group name to be filtered (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 group to apply filter (optional)

unitIp - IP of upgrade units 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.