Class StatusStub

  • All Implemented Interfaces:
    Status, StatusTypes, com.vmware.vapi.bindings.Service

    public class StatusStub
    extends com.vmware.vapi.internal.bindings.Stub
    implements Status
    Remote stub implementation of the Status 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
    • Constructor Summary

      Constructors 
      Constructor Description
      StatusStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      StatusStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)  
    • Method Summary

      All Methods Instance Methods Concrete 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).
      • 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

      • StatusStub

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

        public StatusStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                          com.vmware.vapi.bindings.StubConfigurationBase config)
    • Method Detail

      • get

        public ConsolidatedRealizedStatus get​(java.lang.String intentPath,
                                              java.lang.Boolean includeEnforcedStatus,
                                              java.lang.String sitePath)
        Description copied from interface: Status
        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.

        Specified by:
        get in interface Status
        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
      • get

        public ConsolidatedRealizedStatus get​(java.lang.String intentPath,
                                              java.lang.Boolean includeEnforcedStatus,
                                              java.lang.String sitePath,
                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Status
        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.

        Specified by:
        get in interface Status
        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
      • get

        public void get​(java.lang.String intentPath,
                        java.lang.Boolean includeEnforcedStatus,
                        java.lang.String sitePath,
                        com.vmware.vapi.bindings.client.AsyncCallback<ConsolidatedRealizedStatus> asyncCallback)
        Description copied from interface: Status
        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

        Specified by:
        get in interface Status
        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

        public 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)
        Description copied from interface: Status
        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

        Specified by:
        get in interface Status
        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.