Interface Status

  • All Superinterfaces:
    com.vmware.vapi.bindings.Service, StatusTypes
    All Known Implementing Classes:
    StatusStub

    public interface Status
    extends com.vmware.vapi.bindings.Service, StatusTypes
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ConsolidatedRealizedStatus get​(java.lang.String intentPath, java.lang.Boolean includeEnforcedStatus, java.lang.String sitePath)
      Get Consolidated Status of an intent object (with or without enforcement specific status details).
      void get​(java.lang.String intentPath, java.lang.Boolean includeEnforcedStatus, java.lang.String sitePath, com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedRealizedStatus> asyncCallback)
      Get Consolidated Status of an intent object (with or without enforcement specific status details).
      void get​(java.lang.String intentPath, java.lang.Boolean includeEnforcedStatus, java.lang.String sitePath, com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedRealizedStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Get Consolidated Status of an intent object (with or without enforcement specific status details).
      ConsolidatedRealizedStatus get​(java.lang.String intentPath, java.lang.Boolean includeEnforcedStatus, java.lang.String sitePath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Get Consolidated Status of an intent object (with or without enforcement specific status details).
    • Method Detail

      • get

        ConsolidatedRealizedStatus get​(java.lang.String intentPath,
                                       java.lang.Boolean includeEnforcedStatus,
                                       java.lang.String sitePath)
        Get Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows: - : the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - : the request is evaluated on all enforcement points for the given intent with enforcement point specific details.

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

        Parameters:
        intentPath - Policy Path of the intent object (required)
        includeEnforcedStatus - Include Enforced Status Flag (optional, default to false)
        sitePath - Policy Path of the site from where the realization status needs to be fetched (optional)
        Returns:
        com.vmware.nsx_policy.model.ConsolidatedRealizedStatus
        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

        ConsolidatedRealizedStatus get​(java.lang.String intentPath,
                                       java.lang.Boolean includeEnforcedStatus,
                                       java.lang.String sitePath,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Get Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows: - : the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - : the request is evaluated on all enforcement points for the given intent with enforcement point specific details.

        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:
        intentPath - Policy Path of the intent object (required)
        includeEnforcedStatus - Include Enforced Status Flag (optional, default to false)
        sitePath - Policy Path of the site from where the realization status needs to be fetched (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ConsolidatedRealizedStatus
        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 intentPath,
                 java.lang.Boolean includeEnforcedStatus,
                 java.lang.String sitePath,
                 com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedRealizedStatus> asyncCallback)
        Get Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows: - : the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - : the request is evaluated on all enforcement points for the given intent with enforcement point specific details.

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

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

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

        Parameters:
        intentPath - Policy Path of the intent object (required)
        includeEnforcedStatus - Include Enforced Status Flag (optional, default to false)
        sitePath - Policy Path of the site from where the realization status needs to be fetched (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • get

        void get​(java.lang.String intentPath,
                 java.lang.Boolean includeEnforcedStatus,
                 java.lang.String sitePath,
                 com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedRealizedStatus> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Get Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows: - : the request is evaluated on all enforcement points for the given intent without enforcement point specific details. - : the request is evaluated on all enforcement points for the given intent with enforcement point specific details.

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

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

        Parameters:
        intentPath - Policy Path of the intent object (required)
        includeEnforcedStatus - Include Enforced Status Flag (optional, default to false)
        sitePath - Policy Path of the site from where the realization status needs to be fetched (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.