com.vmware.nsx.logical_routers.nat

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.logical_routers.nat.RulesTypes

_VAPI_SERVICE_ID, LIST_RULE_TYPE_ALL, LIST_RULE_TYPE_NAT64, LIST_RULE_TYPE_NATV4

Method Summary

Modifier and Type	Method and Description
NatRule	create(java.lang.String logicalRouterId, NatRule natRule) Deprecated.
void	create(java.lang.String logicalRouterId, NatRule natRule, com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback) Deprecated.
void	create(java.lang.String logicalRouterId, NatRule natRule, com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRule	create(java.lang.String logicalRouterId, NatRule natRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRuleList	createmultiple(java.lang.String logicalRouterId, NatRuleList natRuleList) Deprecated.
void	createmultiple(java.lang.String logicalRouterId, NatRuleList natRuleList, com.vmware.vapi.bindings.client.AsyncCallback<NatRuleList> asyncCallback) Deprecated.
void	createmultiple(java.lang.String logicalRouterId, NatRuleList natRuleList, com.vmware.vapi.bindings.client.AsyncCallback<NatRuleList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRuleList	createmultiple(java.lang.String logicalRouterId, NatRuleList natRuleList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String ruleId) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRule	get(java.lang.String logicalRouterId, java.lang.String ruleId) Deprecated.
void	get(java.lang.String logicalRouterId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback) Deprecated.
void	get(java.lang.String logicalRouterId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRule	get(java.lang.String logicalRouterId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRuleListResult	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String ruleType, java.lang.Boolean sortAscending, java.lang.String sortBy) Deprecated.
void	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String ruleType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<NatRuleListResult> asyncCallback) Deprecated.
void	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String ruleType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<NatRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRuleListResult	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String ruleType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRule	update(java.lang.String logicalRouterId, java.lang.String ruleId, NatRule natRule) Deprecated.
void	update(java.lang.String logicalRouterId, java.lang.String ruleId, NatRule natRule, com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback) Deprecated.
void	update(java.lang.String logicalRouterId, java.lang.String ruleId, NatRule natRule, com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
NatRule	update(java.lang.String logicalRouterId, java.lang.String ruleId, NatRule natRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
NatRule create(java.lang.String logicalRouterId,
                           NatRule natRule)

Deprecated.

Add a NAT rule in a specific logical router.

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

Parameters:

logicalRouterId - (required)

natRule - (required)

Returns:

com.vmware.nsx.model.NatRule

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

create

@Deprecated
NatRule create(java.lang.String logicalRouterId,
                           NatRule natRule,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Add a NAT rule in a specific logical router.

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:

logicalRouterId - (required)

natRule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NatRule

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

create

@Deprecated
void create(java.lang.String logicalRouterId,
                        NatRule natRule,
                        com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback)

Deprecated.

Add a NAT rule in a specific logical router.

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

Invocation Result:
com.vmware.nsx.model.NatRule

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

Parameters:

logicalRouterId - (required)

natRule - (required)

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

create

@Deprecated
void create(java.lang.String logicalRouterId,
                        NatRule natRule,
                        com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Add a NAT rule in a specific logical router.

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.model.NatRule

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

Parameters:

logicalRouterId - (required)

natRule - (required)

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

invocationConfig - Configuration for the method invocation.

createmultiple

@Deprecated
NatRuleList createmultiple(java.lang.String logicalRouterId,
                                       NatRuleList natRuleList)

Deprecated.

Create multiple NAT rules in a specific logical router. The API succeeds only when all rules are accepted and created successfully. Any one validation voilation will fail the API, no rule will be created. The ruleIds of each rules can be found from the responsed message.

Please use below hierarchical Policy API to create multiple nat rule.
POST /policy/api/v1/infra

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

Parameters:

logicalRouterId - (required)

natRuleList - (required)

Returns:

com.vmware.nsx.model.NatRuleList

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

createmultiple

@Deprecated
NatRuleList createmultiple(java.lang.String logicalRouterId,
                                       NatRuleList natRuleList,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Create multiple NAT rules in a specific logical router. The API succeeds only when all rules are accepted and created successfully. Any one validation voilation will fail the API, no rule will be created. The ruleIds of each rules can be found from the responsed message.

Please use below hierarchical Policy API to create multiple nat rule.
POST /policy/api/v1/infra

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:

logicalRouterId - (required)

natRuleList - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NatRuleList

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

createmultiple

@Deprecated
void createmultiple(java.lang.String logicalRouterId,
                                NatRuleList natRuleList,
                                com.vmware.vapi.bindings.client.AsyncCallback<NatRuleList> asyncCallback)

Deprecated.

Create multiple NAT rules in a specific logical router. The API succeeds only when all rules are accepted and created successfully. Any one validation voilation will fail the API, no rule will be created. The ruleIds of each rules can be found from the responsed message.

Please use below hierarchical Policy API to create multiple nat rule.
POST /policy/api/v1/infra

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

Invocation Result:
com.vmware.nsx.model.NatRuleList

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

Parameters:

logicalRouterId - (required)

natRuleList - (required)

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

createmultiple

@Deprecated
void createmultiple(java.lang.String logicalRouterId,
                                NatRuleList natRuleList,
                                com.vmware.vapi.bindings.client.AsyncCallback<NatRuleList> asyncCallback,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Create multiple NAT rules in a specific logical router. The API succeeds only when all rules are accepted and created successfully. Any one validation voilation will fail the API, no rule will be created. The ruleIds of each rules can be found from the responsed message.

Please use below hierarchical Policy API to create multiple nat rule.
POST /policy/api/v1/infra

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.model.NatRuleList

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

Parameters:

logicalRouterId - (required)

natRuleList - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.String ruleId)

Deprecated.

Delete a specific NAT rule from a logical router

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

Parameters:

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

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Delete a specific NAT rule from a logical router

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:

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

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

Deprecated.

Delete a specific NAT rule from a logical router

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:

logicalRouterId - (required)

ruleId - (required)

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

delete

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

Deprecated.

Delete a specific NAT rule from a logical router

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:

logicalRouterId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
NatRule get(java.lang.String logicalRouterId,
                        java.lang.String ruleId)

Deprecated.

Get a specific NAT rule from a given logical router

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

Parameters:

logicalRouterId - (required)

ruleId - (required)

Returns:

com.vmware.nsx.model.NatRule

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

@Deprecated
NatRule get(java.lang.String logicalRouterId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get a specific NAT rule from a given logical router

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:

logicalRouterId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NatRule

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

@Deprecated
void get(java.lang.String logicalRouterId,
                     java.lang.String ruleId,
                     com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback)

Deprecated.

Get a specific NAT rule from a given logical router

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

Invocation Result:
com.vmware.nsx.model.NatRule

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

Parameters:

logicalRouterId - (required)

ruleId - (required)

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

get

@Deprecated
void get(java.lang.String logicalRouterId,
                     java.lang.String ruleId,
                     com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get a specific NAT rule from a given logical router

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.model.NatRule

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

Parameters:

logicalRouterId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
NatRuleListResult list(java.lang.String logicalRouterId,
                                   java.lang.String cursor,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.String ruleType,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy)

Deprecated.

Returns paginated list of all user defined NAT rules of the specific logical router. If a rule_type is provided, only the given type of rules will be returned. If no rule_type is specified, the rule_type will be defaulted to NATv4, i.e. only the NATv4 rules will be listed.

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

Parameters:

logicalRouterId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

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)

ruleType - Action type for getting NAT rules (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.NatRuleListResult

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

@Deprecated
NatRuleListResult list(java.lang.String logicalRouterId,
                                   java.lang.String cursor,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.String ruleType,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns paginated list of all user defined NAT rules of the specific logical router. If a rule_type is provided, only the given type of rules will be returned. If no rule_type is specified, the rule_type will be defaulted to NATv4, i.e. only the NATv4 rules will be listed.

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:

logicalRouterId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

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)

ruleType - Action type for getting NAT rules (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NatRuleListResult

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

@Deprecated
void list(java.lang.String logicalRouterId,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.String ruleType,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<NatRuleListResult> asyncCallback)

Deprecated.

Returns paginated list of all user defined NAT rules of the specific logical router. If a rule_type is provided, only the given type of rules will be returned. If no rule_type is specified, the rule_type will be defaulted to NATv4, i.e. only the NATv4 rules will be listed.

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

Invocation Result:
com.vmware.nsx.model.NatRuleListResult

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

Parameters:

logicalRouterId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

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)

ruleType - Action type for getting NAT rules (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

@Deprecated
void list(java.lang.String logicalRouterId,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.String ruleType,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<NatRuleListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns paginated list of all user defined NAT rules of the specific logical router. If a rule_type is provided, only the given type of rules will be returned. If no rule_type is specified, the rule_type will be defaulted to NATv4, i.e. only the NATv4 rules will be listed.

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.model.NatRuleListResult

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

Parameters:

logicalRouterId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

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)

ruleType - Action type for getting NAT rules (optional)

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.

update

@Deprecated
NatRule update(java.lang.String logicalRouterId,
                           java.lang.String ruleId,
                           NatRule natRule)

Deprecated.

Update a specific NAT rule from a given logical router.

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

Parameters:

logicalRouterId - (required)

ruleId - (required)

natRule - (required)

Returns:

com.vmware.nsx.model.NatRule

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

@Deprecated
NatRule update(java.lang.String logicalRouterId,
                           java.lang.String ruleId,
                           NatRule natRule,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update a specific NAT rule from a given logical router.

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:

logicalRouterId - (required)

ruleId - (required)

natRule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NatRule

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

@Deprecated
void update(java.lang.String logicalRouterId,
                        java.lang.String ruleId,
                        NatRule natRule,
                        com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback)

Deprecated.

Update a specific NAT rule from a given logical router.

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

Invocation Result:
com.vmware.nsx.model.NatRule

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

Parameters:

logicalRouterId - (required)

ruleId - (required)

natRule - (required)

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

update

@Deprecated
void update(java.lang.String logicalRouterId,
                        java.lang.String ruleId,
                        NatRule natRule,
                        com.vmware.vapi.bindings.client.AsyncCallback<NatRule> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Update a specific NAT rule from a given logical router.

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.model.NatRule

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

Parameters:

logicalRouterId - (required)

ruleId - (required)

natRule - (required)

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

invocationConfig - Configuration for the method invocation.