com.vmware.nsx.cluster.backups

Interface Overview

All Superinterfaces:

OverviewTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

OverviewStub

public interface Overview
extends com.vmware.vapi.bindings.Service, OverviewTypes

Field Summary

Fields inherited from interface com.vmware.nsx.cluster.backups.OverviewTypes

_VAPI_SERVICE_ID, LIST_FRAME_TYPE_GLOBAL_MANAGER, LIST_FRAME_TYPE_LOCAL_LOCAL_MANAGER, LIST_FRAME_TYPE_LOCAL_MANAGER, LIST_FRAME_TYPE_NSX_INTELLIGENCE

Method Summary

Modifier and Type	Method and Description
BackupOverview	list(java.lang.String cursor, java.lang.String frameType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean showBackupsList, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy) Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site.
void	list(java.lang.String cursor, java.lang.String frameType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean showBackupsList, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<BackupOverview> asyncCallback) Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site.
void	list(java.lang.String cursor, java.lang.String frameType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean showBackupsList, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<BackupOverview> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site.
BackupOverview	list(java.lang.String cursor, java.lang.String frameType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean showBackupsList, java.lang.String siteId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site.

Method Detail

list

BackupOverview list(java.lang.String cursor,
                    java.lang.String frameType,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.Boolean showBackupsList,
                    java.lang.String siteId,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy)

Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned.

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)

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

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)

showBackupsList - Need a list of backups (optional, default to true)

siteId - UUID of the site (optional, default to localhost)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.BackupOverview

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

BackupOverview list(java.lang.String cursor,
                    java.lang.String frameType,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.Boolean showBackupsList,
                    java.lang.String siteId,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned.

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)

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

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)

showBackupsList - Need a list of backups (optional, default to true)

siteId - UUID of the site (optional, default to localhost)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BackupOverview

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 cursor,
          java.lang.String frameType,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean showBackupsList,
          java.lang.String siteId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<BackupOverview> asyncCallback)

Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned.

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

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

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)

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

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)

showBackupsList - Need a list of backups (optional, default to true)

siteId - UUID of the site (optional, default to localhost)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

void list(java.lang.String cursor,
          java.lang.String frameType,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean showBackupsList,
          java.lang.String siteId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<BackupOverview> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned.

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

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)

frameType - Frame type (optional, default to LOCAL_LOCAL_MANAGER)

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)

showBackupsList - Need a list of backups (optional, default to true)

siteId - UUID of the site (optional, default to localhost)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.