com.vmware.nsx.upgrade.pre_upgrade_checks

Class FailuresStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.upgrade.pre_upgrade_checks.FailuresStub

All Implemented Interfaces:

Failures, FailuresTypes, com.vmware.vapi.bindings.Service

public class FailuresStub
extends com.vmware.vapi.internal.bindings.Stub
implements Failures

Remote stub implementation of the Failures 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.pre_upgrade_checks.FailuresTypes

_VAPI_SERVICE_ID, LIST_ORIGIN_TYPE_COMPONENT, LIST_ORIGIN_TYPE_UPGRADE_UNIT, LIST_TYPE_FAILURE, LIST_TYPE_WARNING

Constructor Summary

Constructors

Constructor and Description
FailuresStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
FailuresStub(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
UpgradeCheckFailureListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String filterText, java.lang.String groupId, java.lang.String groupName, java.lang.String includedFields, java.lang.Boolean needsAck, java.lang.String originType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, java.lang.String unitId, java.lang.String unitName) Get failures resulting from the last execution of pre-upgrade checks.
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String filterText, java.lang.String groupId, java.lang.String groupName, java.lang.String includedFields, java.lang.Boolean needsAck, java.lang.String originType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, java.lang.String unitId, java.lang.String unitName, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeCheckFailureListResult> asyncCallback) Get failures resulting from the last execution of pre-upgrade checks.
void	list(java.lang.String componentType, java.lang.String cursor, java.lang.String filterText, java.lang.String groupId, java.lang.String groupName, java.lang.String includedFields, java.lang.Boolean needsAck, java.lang.String originType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, java.lang.String unitId, java.lang.String unitName, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeCheckFailureListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get failures resulting from the last execution of pre-upgrade checks.
UpgradeCheckFailureListResult	list(java.lang.String componentType, java.lang.String cursor, java.lang.String filterText, java.lang.String groupId, java.lang.String groupName, java.lang.String includedFields, java.lang.Boolean needsAck, java.lang.String originType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String type, java.lang.String unitId, java.lang.String unitName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get failures resulting from the last execution of pre-upgrade checks.

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

FailuresStub

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

FailuresStub

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

Method Detail

list

public UpgradeCheckFailureListResult list(java.lang.String componentType,
                                          java.lang.String cursor,
                                          java.lang.String filterText,
                                          java.lang.String groupId,
                                          java.lang.String groupName,
                                          java.lang.String includedFields,
                                          java.lang.Boolean needsAck,
                                          java.lang.String originType,
                                          java.lang.Long pageSize,
                                          java.lang.Boolean sortAscending,
                                          java.lang.String sortBy,
                                          java.lang.String type,
                                          java.lang.String unitId,
                                          java.lang.String unitName)

Description copied from interface: Failures

Get failures resulting from the last execution of pre-upgrade checks. If the execution of checks is in progress, the response has the list of failures observed so far.

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

Specified by:

list in interface Failures

Parameters:

componentType - Component type (optional)

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

filterText - Filter text (optional)

groupId - Filter on the group id (optional)

groupName - Filter on the group name (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

needsAck - Filter based on acknowledgement required (optional)

originType - Type of origin of failure (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)

type - Status of the upgrade check (optional)

unitId - Filter on the unit id (optional)

unitName - Filter on the unit name (optional)

Returns:

com.vmware.nsx.model.UpgradeCheckFailureListResult

list

public UpgradeCheckFailureListResult list(java.lang.String componentType,
                                          java.lang.String cursor,
                                          java.lang.String filterText,
                                          java.lang.String groupId,
                                          java.lang.String groupName,
                                          java.lang.String includedFields,
                                          java.lang.Boolean needsAck,
                                          java.lang.String originType,
                                          java.lang.Long pageSize,
                                          java.lang.Boolean sortAscending,
                                          java.lang.String sortBy,
                                          java.lang.String type,
                                          java.lang.String unitId,
                                          java.lang.String unitName,
                                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Failures

Get failures resulting from the last execution of pre-upgrade checks. If the execution of checks is in progress, the response has the list of failures observed so far.

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 Failures

Parameters:

componentType - Component type (optional)

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

filterText - Filter text (optional)

groupId - Filter on the group id (optional)

groupName - Filter on the group name (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

needsAck - Filter based on acknowledgement required (optional)

originType - Type of origin of failure (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)

type - Status of the upgrade check (optional)

unitId - Filter on the unit id (optional)

unitName - Filter on the unit name (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.UpgradeCheckFailureListResult

list

public void list(java.lang.String componentType,
                 java.lang.String cursor,
                 java.lang.String filterText,
                 java.lang.String groupId,
                 java.lang.String groupName,
                 java.lang.String includedFields,
                 java.lang.Boolean needsAck,
                 java.lang.String originType,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String type,
                 java.lang.String unitId,
                 java.lang.String unitName,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeCheckFailureListResult> asyncCallback)

Description copied from interface: Failures

Get failures resulting from the last execution of pre-upgrade checks. If the execution of checks is in progress, the response has the list of failures observed so far.

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

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

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

Specified by:

list in interface Failures

Parameters:

componentType - Component type (optional)

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

filterText - Filter text (optional)

groupId - Filter on the group id (optional)

groupName - Filter on the group name (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

needsAck - Filter based on acknowledgement required (optional)

originType - Type of origin of failure (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)

type - Status of the upgrade check (optional)

unitId - Filter on the unit id (optional)

unitName - Filter on the unit name (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 filterText,
                 java.lang.String groupId,
                 java.lang.String groupName,
                 java.lang.String includedFields,
                 java.lang.Boolean needsAck,
                 java.lang.String originType,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String type,
                 java.lang.String unitId,
                 java.lang.String unitName,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeCheckFailureListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Failures

Get failures resulting from the last execution of pre-upgrade checks. If the execution of checks is in progress, the response has the list of failures observed so far.

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

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

Specified by:

list in interface Failures

Parameters:

componentType - Component type (optional)

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

filterText - Filter text (optional)

groupId - Filter on the group id (optional)

groupName - Filter on the group name (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

needsAck - Filter based on acknowledgement required (optional)

originType - Type of origin of failure (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)

type - Status of the upgrade check (optional)

unitId - Filter on the unit id (optional)

unitName - Filter on the unit name (optional)

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

invocationConfig - Configuration for the method invocation.