Interface Topology

  • All Superinterfaces:
    com.vmware.vapi.bindings.Service, TopologyTypes
    All Known Implementing Classes:
    TopologyStub

    public interface Topology
    extends com.vmware.vapi.bindings.Service, TopologyTypes
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      UpgradeTopology apply​(UpgradeTopology upgradeTopology, java.lang.String clusterId, java.lang.Boolean useRecommendedTopologyConfig)
      Deprecated.
      void apply​(UpgradeTopology upgradeTopology, java.lang.String clusterId, java.lang.Boolean useRecommendedTopologyConfig, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback)
      Deprecated.
      void apply​(UpgradeTopology upgradeTopology, java.lang.String clusterId, java.lang.Boolean useRecommendedTopologyConfig, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Deprecated.
      UpgradeTopology apply​(UpgradeTopology upgradeTopology, java.lang.String clusterId, java.lang.Boolean useRecommendedTopologyConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Deprecated.
      UpgradeTopology get​(java.lang.String precheckId, java.lang.String clusterId, java.lang.String computeManagerId, java.lang.Boolean showVdsConfig)
      Deprecated.
      void get​(java.lang.String precheckId, java.lang.String clusterId, java.lang.String computeManagerId, java.lang.Boolean showVdsConfig, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback)
      Deprecated.
      void get​(java.lang.String precheckId, java.lang.String clusterId, java.lang.String computeManagerId, java.lang.Boolean showVdsConfig, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Deprecated.
      UpgradeTopology get​(java.lang.String precheckId, java.lang.String clusterId, java.lang.String computeManagerId, java.lang.Boolean showVdsConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Deprecated.
      UpgradeTopology revert​(UpgradeTopology upgradeTopology)
      Deprecated.
      void revert​(UpgradeTopology upgradeTopology, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback)
      Deprecated.
      void revert​(UpgradeTopology upgradeTopology, com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Deprecated.
      UpgradeTopology revert​(UpgradeTopology upgradeTopology, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Deprecated.
    • Method Detail

      • apply

        @Deprecated
        UpgradeTopology apply​(UpgradeTopology upgradeTopology,
                              java.lang.String clusterId,
                              java.lang.Boolean useRecommendedTopologyConfig)
        Deprecated.
        Upon successful preheck status goes to PENDING_TOPOLOGY and global recommended topology is generated which can be retrieved via GetRecommendedVdsTopology API. User can apply the entire recommeneded topology all together or can apply partial depending on which TrasportNodes user wants to be upgraded from NVDS to CVDS. User can change system generated vds_name field, all other fields cannot be changed when applying topology.

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

        Parameters:
        upgradeTopology - (required)
        clusterId - cluster identifier (optional)
        useRecommendedTopologyConfig - Flag to indicate if use recommended topology got from the latest precheck (optional)
        Returns:
        com.vmware.nsx.model.UpgradeTopology
        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
      • apply

        @Deprecated
        UpgradeTopology apply​(UpgradeTopology upgradeTopology,
                              java.lang.String clusterId,
                              java.lang.Boolean useRecommendedTopologyConfig,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Deprecated.
        Upon successful preheck status goes to PENDING_TOPOLOGY and global recommended topology is generated which can be retrieved via GetRecommendedVdsTopology API. User can apply the entire recommeneded topology all together or can apply partial depending on which TrasportNodes user wants to be upgraded from NVDS to CVDS. User can change system generated vds_name field, all other fields cannot be changed when applying topology.

        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:
        upgradeTopology - (required)
        clusterId - cluster identifier (optional)
        useRecommendedTopologyConfig - Flag to indicate if use recommended topology got from the latest precheck (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx.model.UpgradeTopology
        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
      • apply

        @Deprecated
        void apply​(UpgradeTopology upgradeTopology,
                   java.lang.String clusterId,
                   java.lang.Boolean useRecommendedTopologyConfig,
                   com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback)
        Deprecated.
        Upon successful preheck status goes to PENDING_TOPOLOGY and global recommended topology is generated which can be retrieved via GetRecommendedVdsTopology API. User can apply the entire recommeneded topology all together or can apply partial depending on which TrasportNodes user wants to be upgraded from NVDS to CVDS. User can change system generated vds_name field, all other fields cannot be changed when applying topology.

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

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

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

        Parameters:
        upgradeTopology - (required)
        clusterId - cluster identifier (optional)
        useRecommendedTopologyConfig - Flag to indicate if use recommended topology got from the latest precheck (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • apply

        @Deprecated
        void apply​(UpgradeTopology upgradeTopology,
                   java.lang.String clusterId,
                   java.lang.Boolean useRecommendedTopologyConfig,
                   com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Deprecated.
        Upon successful preheck status goes to PENDING_TOPOLOGY and global recommended topology is generated which can be retrieved via GetRecommendedVdsTopology API. User can apply the entire recommeneded topology all together or can apply partial depending on which TrasportNodes user wants to be upgraded from NVDS to CVDS. User can change system generated vds_name field, all other fields cannot be changed when applying topology.

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

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

        Parameters:
        upgradeTopology - (required)
        clusterId - cluster identifier (optional)
        useRecommendedTopologyConfig - Flag to indicate if use recommended topology got from the latest precheck (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • get

        @Deprecated
        UpgradeTopology get​(java.lang.String precheckId,
                            java.lang.String clusterId,
                            java.lang.String computeManagerId,
                            java.lang.Boolean showVdsConfig)
        Deprecated.
        This returns global recommended topology generated when precheck is successful.

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

        Parameters:
        precheckId - (required)
        clusterId - cluster identifier (optional)
        computeManagerId - vCenter identifier (optional)
        showVdsConfig - Flag to indicate if VdsTopology should contain VDS configuration (optional)
        Returns:
        com.vmware.nsx.model.UpgradeTopology
        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

        @Deprecated
        UpgradeTopology get​(java.lang.String precheckId,
                            java.lang.String clusterId,
                            java.lang.String computeManagerId,
                            java.lang.Boolean showVdsConfig,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Deprecated.
        This returns global recommended topology generated when precheck is successful.

        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:
        precheckId - (required)
        clusterId - cluster identifier (optional)
        computeManagerId - vCenter identifier (optional)
        showVdsConfig - Flag to indicate if VdsTopology should contain VDS configuration (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx.model.UpgradeTopology
        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

        @Deprecated
        void get​(java.lang.String precheckId,
                 java.lang.String clusterId,
                 java.lang.String computeManagerId,
                 java.lang.Boolean showVdsConfig,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback)
        Deprecated.
        This returns global recommended topology generated when precheck is successful.

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

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

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

        Parameters:
        precheckId - (required)
        clusterId - cluster identifier (optional)
        computeManagerId - vCenter identifier (optional)
        showVdsConfig - Flag to indicate if VdsTopology should contain VDS configuration (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • get

        @Deprecated
        void get​(java.lang.String precheckId,
                 java.lang.String clusterId,
                 java.lang.String computeManagerId,
                 java.lang.Boolean showVdsConfig,
                 com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Deprecated.
        This returns global recommended topology generated when precheck is successful.

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

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

        Parameters:
        precheckId - (required)
        clusterId - cluster identifier (optional)
        computeManagerId - vCenter identifier (optional)
        showVdsConfig - Flag to indicate if VdsTopology should contain VDS configuration (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • revert

        @Deprecated
        UpgradeTopology revert​(UpgradeTopology upgradeTopology)
        Deprecated.
        This will revert corresponding VDS to PENDING_TOPOLOGY state. User can revert the entire topology all together or can revert partially depending on which TrasportNodes user does not want to upgrade to VDS.

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

        Parameters:
        upgradeTopology - (required)
        Returns:
        com.vmware.nsx.model.UpgradeTopology
        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
      • revert

        @Deprecated
        UpgradeTopology revert​(UpgradeTopology upgradeTopology,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Deprecated.
        This will revert corresponding VDS to PENDING_TOPOLOGY state. User can revert the entire topology all together or can revert partially depending on which TrasportNodes user does not want to upgrade to VDS.

        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:
        upgradeTopology - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx.model.UpgradeTopology
        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
      • revert

        @Deprecated
        void revert​(UpgradeTopology upgradeTopology,
                    com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback)
        Deprecated.
        This will revert corresponding VDS to PENDING_TOPOLOGY state. User can revert the entire topology all together or can revert partially depending on which TrasportNodes user does not want to upgrade to VDS.

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

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

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

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

        @Deprecated
        void revert​(UpgradeTopology upgradeTopology,
                    com.vmware.vapi.bindings.client.AsyncCallback<UpgradeTopology> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Deprecated.
        This will revert corresponding VDS to PENDING_TOPOLOGY state. User can revert the entire topology all together or can revert partially depending on which TrasportNodes user does not want to upgrade to VDS.

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

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

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