Package com.vmware.nsx_policy.cluster.backups

Class OverviewStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.cluster.backups.OverviewStub

All Implemented Interfaces:

Overview, OverviewTypes, com.vmware.vapi.bindings.Service

public class OverviewStub
extends com.vmware.vapi.internal.bindings.Stub
implements Overview

Remote stub implementation of the Overview 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_policy.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

Constructor Summary

Constructors

Constructor	Description
OverviewStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
OverviewStub(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	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.

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

OverviewStub

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

OverviewStub

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

Method Detail

list

public 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)

Description copied from interface: Overview

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.

Specified by:

list in interface Overview

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

list

public 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)

Description copied from interface: Overview

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.

Specified by:

list in interface Overview

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

list

public 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)

Description copied from interface: Overview

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

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

Specified by:

list in interface Overview

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

public 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)

Description copied from interface: Overview

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

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

Specified by:

list in interface Overview

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.