com.vmware.nsx.cluster.backups

Interface UiFrames

All Superinterfaces:

com.vmware.vapi.bindings.Service, UiFramesTypes

All Known Implementing Classes:

UiFramesStub

public interface UiFrames
extends com.vmware.vapi.bindings.Service, UiFramesTypes

Field Summary

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

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.

Method Detail

get

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.

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

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

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

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.

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:

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

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

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

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

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.

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

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.