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
      void delete​(java.lang.String policyId, java.lang.String ruleId)
      Delete rule
      void delete​(java.lang.String policyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete rule
      void delete​(java.lang.String policyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete rule
      void delete​(java.lang.String policyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete rule
      TlsRule get​(java.lang.String policyId, java.lang.String ruleId)
      Read rule
      void get​(java.lang.String policyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback)
      Read rule
      void get​(java.lang.String policyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read rule
      TlsRule get​(java.lang.String policyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read rule
      TlsRuleListResult list​(java.lang.String policyId, 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 TLS rules
      void list​(java.lang.String policyId, 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<TlsRuleListResult> asyncCallback)
      List TLS rules
      void list​(java.lang.String policyId, 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<TlsRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List TLS rules
      TlsRuleListResult list​(java.lang.String policyId, 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 TLS rules
      TlsRule patch​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule)
      Update the TLS rule.
      void patch​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule, com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback)
      Update the TLS rule.
      void patch​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule, com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Update the TLS rule.
      TlsRule patch​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Update the TLS rule.
      TlsRule update​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule)
      Update the TLS rule.
      void update​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule, com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback)
      Update the TLS rule.
      void update​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule, com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Update the TLS rule.
      TlsRule update​(java.lang.String policyId, java.lang.String ruleId, TlsRule tlsRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Update the TLS rule.
      • 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

      • delete

        public void delete​(java.lang.String policyId,
                           java.lang.String ruleId)
        Description copied from interface: Rules
        Delete rule

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

        Specified by:
        delete in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
      • delete

        public void delete​(java.lang.String policyId,
                           java.lang.String ruleId,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Delete 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:
        delete in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        invocationConfig - Configuration for the method invocation.
      • delete

        public void delete​(java.lang.String policyId,
                           java.lang.String ruleId,
                           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Description copied from interface: Rules
        Delete rule

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

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

        Specified by:
        delete in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • delete

        public void delete​(java.lang.String policyId,
                           java.lang.String ruleId,
                           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Delete rule

        Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

        Specified by:
        delete in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • get

        public TlsRule get​(java.lang.String policyId,
                           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:
        policyId - (required)
        ruleId - (required)
        Returns:
        com.vmware.nsx_policy.model.TlsRule
      • get

        public TlsRule get​(java.lang.String policyId,
                           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:
        policyId - (required)
        ruleId - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.TlsRule
      • get

        public void get​(java.lang.String policyId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> 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.TlsRule

        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:
        policyId - (required)
        ruleId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • get

        public void get​(java.lang.String policyId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> 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.TlsRule

        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:
        policyId - (required)
        ruleId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • list

        public TlsRuleListResult list​(java.lang.String policyId,
                                      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 TLS rules

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

        Specified by:
        list in interface Rules
        Parameters:
        policyId - (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.TlsRuleListResult
      • list

        public TlsRuleListResult list​(java.lang.String policyId,
                                      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 TLS 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:
        policyId - (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.TlsRuleListResult
      • list

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

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

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

        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:
        policyId - (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 policyId,
                         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<TlsRuleListResult> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        List TLS 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.TlsRuleListResult

        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:
        policyId - (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.
      • patch

        public TlsRule patch​(java.lang.String policyId,
                             java.lang.String ruleId,
                             TlsRule tlsRule)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

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

        Specified by:
        patch in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        Returns:
        com.vmware.nsx_policy.model.TlsRule
      • patch

        public TlsRule patch​(java.lang.String policyId,
                             java.lang.String ruleId,
                             TlsRule tlsRule,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

        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:
        patch in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.TlsRule
      • patch

        public void patch​(java.lang.String policyId,
                          java.lang.String ruleId,
                          TlsRule tlsRule,
                          com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

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

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

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

        Specified by:
        patch in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • patch

        public void patch​(java.lang.String policyId,
                          java.lang.String ruleId,
                          TlsRule tlsRule,
                          com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

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

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

        Specified by:
        patch in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • update

        public TlsRule update​(java.lang.String policyId,
                              java.lang.String ruleId,
                              TlsRule tlsRule)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

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

        Specified by:
        update in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        Returns:
        com.vmware.nsx_policy.model.TlsRule
      • update

        public TlsRule update​(java.lang.String policyId,
                              java.lang.String ruleId,
                              TlsRule tlsRule,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

        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:
        update in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.TlsRule
      • update

        public void update​(java.lang.String policyId,
                           java.lang.String ruleId,
                           TlsRule tlsRule,
                           com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

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

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

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

        Specified by:
        update in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • update

        public void update​(java.lang.String policyId,
                           java.lang.String ruleId,
                           TlsRule tlsRule,
                           com.vmware.vapi.bindings.client.AsyncCallback<TlsRule> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Rules
        Update the TLS rule. Create new rule if a rule with the rule-id is not already present. Performance Note: If you want to edit several rules in a TLS policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/tls-inspection-policies/

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

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

        Specified by:
        update in interface Rules
        Parameters:
        policyId - (required)
        ruleId - (required)
        tlsRule - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.