com.vmware.nsx.upgrade

Interface StatusSummary

All Superinterfaces:

com.vmware.vapi.bindings.Service, StatusSummaryTypes

All Known Implementing Classes:

StatusSummaryStub

public interface StatusSummary
extends com.vmware.vapi.bindings.Service, StatusSummaryTypes

Field Summary

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

_VAPI_SERVICE_ID, GET_SELECTION_STATUS_ALL, GET_SELECTION_STATUS_DESELECTED, GET_SELECTION_STATUS_SELECTED

Method Summary

Modifier and Type	Method and Description
UpgradeStatus	get(java.lang.String componentType, java.lang.String selectionStatus, java.lang.Boolean showHistory) Get upgrade status summary
void	get(java.lang.String componentType, java.lang.String selectionStatus, java.lang.Boolean showHistory, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeStatus> asyncCallback) Get upgrade status summary
void	get(java.lang.String componentType, java.lang.String selectionStatus, java.lang.Boolean showHistory, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade status summary
UpgradeStatus	get(java.lang.String componentType, java.lang.String selectionStatus, java.lang.Boolean showHistory, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get upgrade status summary

Method Detail

get

UpgradeStatus get(java.lang.String componentType,
                  java.lang.String selectionStatus,
                  java.lang.Boolean showHistory)

Get upgrade status summary

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

Parameters:

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

selectionStatus - Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units (optional, default to ALL)

showHistory - Get upgrade activity for a given component (optional)

Returns:

com.vmware.nsx.model.UpgradeStatus

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

get

UpgradeStatus get(java.lang.String componentType,
                  java.lang.String selectionStatus,
                  java.lang.Boolean showHistory,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get upgrade status summary

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 units to be filtered (optional)

selectionStatus - Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units (optional, default to ALL)

showHistory - Get upgrade activity for a given component (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeStatus

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

get

void get(java.lang.String componentType,
         java.lang.String selectionStatus,
         java.lang.Boolean showHistory,
         com.vmware.vapi.bindings.client.AsyncCallback<UpgradeStatus> asyncCallback)

Get upgrade status summary

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

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

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 units to be filtered (optional)

selectionStatus - Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units (optional, default to ALL)

showHistory - Get upgrade activity for a given component (optional)

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

get

void get(java.lang.String componentType,
         java.lang.String selectionStatus,
         java.lang.Boolean showHistory,
         com.vmware.vapi.bindings.client.AsyncCallback<UpgradeStatus> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get upgrade status summary

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

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 units to be filtered (optional)

selectionStatus - Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units (optional, default to ALL)

showHistory - Get upgrade activity for a given component (optional)

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

invocationConfig - Configuration for the method invocation.