Package com.vmware.nsx_policy.infra.domains.gateway_policies

Interface Rules

All Superinterfaces:

RulesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RulesStub

public interface Rules
extends com.vmware.vapi.bindings.Service, RulesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.domains.gateway_policies.RulesTypes

_VAPI_SERVICE_ID, REVISE_OPERATION_AFTER, REVISE_OPERATION_BEFORE, REVISE_OPERATION_BOTTOM, REVISE_OPERATION_TOP

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId)	Delete rule
void	delete(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete rule
void	delete(java.lang.String domainId, java.lang.String gatewayPolicyId, 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 domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete rule
Rule	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId)	Read rule
void	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)	Read rule
void	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read rule
Rule	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read rule
RuleListResult	list(java.lang.String domainId, java.lang.String gatewayPolicyId, 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 gatewayPolicyId, 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<RuleListResult> asyncCallback)	List rules
void	list(java.lang.String domainId, java.lang.String gatewayPolicyId, 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<RuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List rules
RuleListResult	list(java.lang.String domainId, java.lang.String gatewayPolicyId, 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
void	patch(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule)	Update the gateway rule.
void	patch(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Update the gateway rule.
void	patch(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Update the gateway rule.
void	patch(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Update the gateway rule.
Rule	revise(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, java.lang.String anchorPath, java.lang.String operation)	This is used to re-order a gateway rule within a gateway policy.
void	revise(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, java.lang.String anchorPath, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)	This is used to re-order a gateway rule within a gateway policy.
void	revise(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, java.lang.String anchorPath, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	This is used to re-order a gateway rule within a gateway policy.
Rule	revise(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, java.lang.String anchorPath, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	This is used to re-order a gateway rule within a gateway policy.
Rule	update(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule)	Update the gateway rule.
void	update(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)	Update the gateway rule.
void	update(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Update the gateway rule.
Rule	update(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, Rule rule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Update the gateway rule.

Method Detail

delete

void delete(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId)

Delete rule

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

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

delete

void delete(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

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

delete

void delete(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

Rule get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId)

Read rule

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

Returns:

com.vmware.nsx_policy.model.Rule

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

Rule get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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.

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Rule

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 domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId,
         com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)

Read rule

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId,
         com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

RuleListResult list(java.lang.String domainId,
                    java.lang.String gatewayPolicyId,
                    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

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

Parameters:

domainId - (required)

gatewayPolicyId - (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.RuleListResult

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

list

RuleListResult list(java.lang.String domainId,
                    java.lang.String gatewayPolicyId,
                    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

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:

domainId - (required)

gatewayPolicyId - (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.RuleListResult

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

list

void list(java.lang.String domainId,
          java.lang.String gatewayPolicyId,
          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<RuleListResult> asyncCallback)

List rules

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (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

void list(java.lang.String domainId,
          java.lang.String gatewayPolicyId,
          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<RuleListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (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

void patch(java.lang.String domainId,
           java.lang.String gatewayPolicyId,
           java.lang.String ruleId,
           Rule rule)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

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

patch

void patch(java.lang.String domainId,
           java.lang.String gatewayPolicyId,
           java.lang.String ruleId,
           Rule rule,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

invocationConfig - Configuration for the method invocation.

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

patch

void patch(java.lang.String domainId,
           java.lang.String gatewayPolicyId,
           java.lang.String ruleId,
           Rule rule,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

patch

void patch(java.lang.String domainId,
           java.lang.String gatewayPolicyId,
           java.lang.String ruleId,
           Rule rule,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

revise

Rule revise(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            java.lang.String anchorPath,
            java.lang.String operation)

This is used to re-order a gateway rule within a gateway policy.

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

anchorPath - The security policy/rule path if operation is 'insert_after' or 'insert_before' (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx_policy.model.Rule

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

revise

Rule revise(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            java.lang.String anchorPath,
            java.lang.String operation,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This is used to re-order a gateway rule within a gateway policy.

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:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

anchorPath - The security policy/rule path if operation is 'insert_after' or 'insert_before' (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Rule

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

revise

void revise(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            java.lang.String anchorPath,
            java.lang.String operation,
            com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)

This is used to re-order a gateway rule within a gateway policy.

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

anchorPath - The security policy/rule path if operation is 'insert_after' or 'insert_before' (optional)

operation - Operation (optional, default to insert_top)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

revise

void revise(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            java.lang.String anchorPath,
            java.lang.String operation,
            com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This is used to re-order a gateway rule within a gateway policy.

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

anchorPath - The security policy/rule path if operation is 'insert_after' or 'insert_before' (optional)

operation - Operation (optional, default to insert_top)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

Rule update(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

Returns:

com.vmware.nsx_policy.model.Rule

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

update

Rule update(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Rule

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

update

void update(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(java.lang.String domainId,
            java.lang.String gatewayPolicyId,
            java.lang.String ruleId,
            Rule rule,
            com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Update the gateway 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 gateway 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/domains//gateway-policies/ Concurrency Note: Concurrent firewall rule creation is not supported under the same Gateway Policy.

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

rule - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.