Interface Restore

  • All Superinterfaces:
    RestoreTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    RestoreStub

    public interface Restore
    extends com.vmware.vapi.bindings.Service, RestoreTypes
    • Method Detail

      • advance

        ClusterRestoreStatus advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest)
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.

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

        Parameters:
        advanceClusterRestoreRequest - (required)
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • advance

        ClusterRestoreStatus advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is 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:
        advanceClusterRestoreRequest - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • advance

        void advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest,
                     com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.

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

        Invocation Result:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

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

        Parameters:
        advanceClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • advance

        void advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest,
                     com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is 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.ClusterRestoreStatus

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

        Parameters:
        advanceClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • cancel

        ClusterRestoreStatus cancel()
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

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

        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • cancel

        ClusterRestoreStatus cancel​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

        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:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • cancel

        void cancel​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

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

        Invocation Result:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

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

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

        void cancel​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

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

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

        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • retry

        ClusterRestoreStatus retry()
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.

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

        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • retry

        ClusterRestoreStatus retry​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is 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:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • retry

        void retry​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.

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

        Invocation Result:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

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

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

        void retry​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is 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.ClusterRestoreStatus

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

        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • start

        ClusterRestoreStatus start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest)
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.

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

        Parameters:
        initiateClusterRestoreRequest - (required)
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • start

        ClusterRestoreStatus start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is 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:
        initiateClusterRestoreRequest - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • start

        void start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest,
                   com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.

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

        Invocation Result:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

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

        Parameters:
        initiateClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • start

        void start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest,
                   com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is 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.ClusterRestoreStatus

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

        Parameters:
        initiateClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • suspend

        ClusterRestoreStatus suspend()
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.

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

        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • suspend

        ClusterRestoreStatus suspend​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is 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:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus
        Throws:
        com.vmware.vapi.std.errors.ConcurrentChange - Conflict
        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
      • suspend

        void suspend​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.

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

        Invocation Result:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

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

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

        void suspend​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is 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.ClusterRestoreStatus

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

        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.