Package com.vmware.nsx_policy.global_infra.tier_0s

Class NatStub

  • All Implemented Interfaces:
    Nat, NatTypes, com.vmware.vapi.bindings.Service
    public class NatStub
extends com.vmware.vapi.internal.bindings.Stub
implements Nat
    Remote stub implementation of the Nat 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
      NatStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      NatStub​(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
      PolicyNatListResult list​(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      List all NAT sections under the given Tier-0 ID.
      void list​(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatListResult> asyncCallback)
      List all NAT sections under the given Tier-0 ID.
      void list​(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List all NAT sections under the given Tier-0 ID.
      PolicyNatListResult list​(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List all NAT sections under the given Tier-0 ID.

      • 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

      • NatStub

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

      • NatStub

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

    • Method Detail

      • list

        public PolicyNatListResult list​(java.lang.String tier0Id,
                                java.lang.String cursor,
                                java.lang.Boolean includeMarkForDeleteObjects,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy)
        Description copied from interface: Nat
        List all NAT sections under the given Tier-0 ID. For more details related to NAT section please refer to PolicyNAT schema.

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

        Specified by:
        list in interface Nat
        Parameters:
        tier0Id - Tier-0 ID (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        Returns:
        com.vmware.nsx_policy.model.PolicyNatListResult

      • list

        public PolicyNatListResult list​(java.lang.String tier0Id,
                                java.lang.String cursor,
                                java.lang.Boolean includeMarkForDeleteObjects,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Nat
        List all NAT sections under the given Tier-0 ID. For more details related to NAT section please refer to PolicyNAT schema.

        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 Nat
        Parameters:
        tier0Id - Tier-0 ID (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.PolicyNatListResult

      • list

        public void list​(java.lang.String tier0Id,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatListResult> asyncCallback)
        Description copied from interface: Nat
        List all NAT sections under the given Tier-0 ID. For more details related to NAT section please refer to PolicyNAT schema.

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

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

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

        Specified by:
        list in interface Nat
        Parameters:
        tier0Id - Tier-0 ID (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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)
        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 tier0Id,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<PolicyNatListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Nat
        List all NAT sections under the given Tier-0 ID. For more details related to NAT section please refer to PolicyNAT schema.

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

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

        Specified by:
        list in interface Nat
        Parameters:
        tier0Id - Tier-0 ID (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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)
        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.