Package com.vmware.nsx_policy.global_infra.domains.forwarding_policies

Class RulesStub

  • All Implemented Interfaces:
    Rules, RulesTypes, com.vmware.vapi.bindings.Service
    public class RulesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Rules
    Remote stub implementation of the Rules 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
      RulesStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      RulesStub​(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
      ForwardingRule get​(java.lang.String domainId, java.lang.String forwardingPolicyId, java.lang.String ruleId)
      Read rule
      void get​(java.lang.String domainId, java.lang.String forwardingPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<ForwardingRule> asyncCallback)
      Read rule
      void get​(java.lang.String domainId, java.lang.String forwardingPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<ForwardingRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read rule
      ForwardingRule get​(java.lang.String domainId, java.lang.String forwardingPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read rule
      ForwardingRuleListResult list​(java.lang.String domainId, java.lang.String forwardingPolicyId, 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 rules
      void list​(java.lang.String domainId, java.lang.String forwardingPolicyId, 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<ForwardingRuleListResult> asyncCallback)
      List rules
      void list​(java.lang.String domainId, java.lang.String forwardingPolicyId, 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<ForwardingRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List rules
      ForwardingRuleListResult list​(java.lang.String domainId, java.lang.String forwardingPolicyId, 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 rules

      • 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

      • RulesStub

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

      • RulesStub

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

    • Method Detail

      • get

        public ForwardingRule get​(java.lang.String domainId,
                          java.lang.String forwardingPolicyId,
                          java.lang.String ruleId)
        Description copied from interface: Rules
        Read rule

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

        Specified by:
        get in interface Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map id (required)
        ruleId - Rule id (required)
        Returns:
        com.vmware.nsx_policy.model.ForwardingRule

      • get

        public ForwardingRule get​(java.lang.String domainId,
                          java.lang.String forwardingPolicyId,
                          java.lang.String ruleId,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Read rule

        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 Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map id (required)
        ruleId - Rule id (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ForwardingRule

      • get

        public void get​(java.lang.String domainId,
                java.lang.String forwardingPolicyId,
                java.lang.String ruleId,
                com.vmware.vapi.bindings.client.AsyncCallback<ForwardingRule> asyncCallback)
        Description copied from interface: Rules
        Read rule

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

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

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

        Specified by:
        get in interface Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map id (required)
        ruleId - Rule id (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        public void get​(java.lang.String domainId,
                java.lang.String forwardingPolicyId,
                java.lang.String ruleId,
                com.vmware.vapi.bindings.client.AsyncCallback<ForwardingRule> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Read rule

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

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

        Specified by:
        get in interface Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map id (required)
        ruleId - Rule id (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • list

        public ForwardingRuleListResult list​(java.lang.String domainId,
                                     java.lang.String forwardingPolicyId,
                                     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: Rules
        List rules

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

        Specified by:
        list in interface Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map 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.ForwardingRuleListResult

      • list

        public ForwardingRuleListResult list​(java.lang.String domainId,
                                     java.lang.String forwardingPolicyId,
                                     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: Rules
        List rules

        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 Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map 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.ForwardingRuleListResult

      • list

        public void list​(java.lang.String domainId,
                 java.lang.String forwardingPolicyId,
                 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<ForwardingRuleListResult> asyncCallback)
        Description copied from interface: Rules
        List rules

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

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

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

        Specified by:
        list in interface Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map 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 domainId,
                 java.lang.String forwardingPolicyId,
                 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<ForwardingRuleListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        List rules

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

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

        Specified by:
        list in interface Rules
        Parameters:
        domainId - Domain id (required)
        forwardingPolicyId - Forwarding map 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.