com.vmware.nsx.cluster.backups

Class UiFramesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.cluster.backups.UiFramesStub

All Implemented Interfaces:

UiFrames, UiFramesTypes, com.vmware.vapi.bindings.Service

public class UiFramesStub
extends com.vmware.vapi.internal.bindings.Stub
implements UiFrames

Remote stub implementation of the UiFrames 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.cluster.backups.UiFramesTypes

_VAPI_SERVICE_ID, GET_UI_TAB_TYPE_GLOBAL_MANAGER_TAB, GET_UI_TAB_TYPE_LOCAL_MANAGER_TAB

Constructor Summary

Constructors

Constructor and Description
UiFramesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
UiFramesStub(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
BackupUiFramesInfoList	get(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uiTabType) Returns list of backup frames and some metadata to be used by UI.
void	get(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uiTabType, com.vmware.vapi.bindings.client.AsyncCallback<BackupUiFramesInfoList> asyncCallback) Returns list of backup frames and some metadata to be used by UI.
void	get(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uiTabType, com.vmware.vapi.bindings.client.AsyncCallback<BackupUiFramesInfoList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns list of backup frames and some metadata to be used by UI.
BackupUiFramesInfoList	get(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uiTabType, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns list of backup frames and some metadata to be used by UI.

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

UiFramesStub

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

UiFramesStub

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

Method Detail

get

public BackupUiFramesInfoList get(java.lang.String cursor,
                                  java.lang.String includedFields,
                                  java.lang.Long pageSize,
                                  java.lang.Boolean sortAscending,
                                  java.lang.String sortBy,
                                  java.lang.String uiTabType)

Description copied from interface: UiFrames

Returns list of backup frames and some metadata to be used by UI.

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

Specified by:

get in interface UiFrames

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

uiTabType - (optional, default to LOCAL_MANAGER_TAB)

Returns:

com.vmware.nsx.model.BackupUiFramesInfoList

get

public BackupUiFramesInfoList get(java.lang.String cursor,
                                  java.lang.String includedFields,
                                  java.lang.Long pageSize,
                                  java.lang.Boolean sortAscending,
                                  java.lang.String sortBy,
                                  java.lang.String uiTabType,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: UiFrames

Returns list of backup frames and some metadata to be used by UI.

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:

get in interface UiFrames

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

uiTabType - (optional, default to LOCAL_MANAGER_TAB)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BackupUiFramesInfoList

get

public void get(java.lang.String cursor,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String uiTabType,
                com.vmware.vapi.bindings.client.AsyncCallback<BackupUiFramesInfoList> asyncCallback)

Description copied from interface: UiFrames

Returns list of backup frames and some metadata to be used by UI.

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

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

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

Specified by:

get in interface UiFrames

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

uiTabType - (optional, default to LOCAL_MANAGER_TAB)

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

get

public void get(java.lang.String cursor,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String uiTabType,
                com.vmware.vapi.bindings.client.AsyncCallback<BackupUiFramesInfoList> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: UiFrames

Returns list of backup frames and some metadata to be used by UI.

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

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

Specified by:

get in interface UiFrames

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (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)

uiTabType - (optional, default to LOCAL_MANAGER_TAB)

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

invocationConfig - Configuration for the method invocation.