com.vmware.nsx.firewall.sections

Class RulesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.firewall.sections.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

Fields inherited from interface com.vmware.nsx.firewall.sections.RulesTypes

_VAPI_SERVICE_ID, CREATE_OPERATION_AFTER, CREATE_OPERATION_BEFORE, CREATE_OPERATION_BOTTOM, CREATE_OPERATION_TOP, CREATEMULTIPLE_OPERATION_AFTER, CREATEMULTIPLE_OPERATION_BEFORE, CREATEMULTIPLE_OPERATION_BOTTOM, CREATEMULTIPLE_OPERATION_TOP, LIST_FILTER_TYPE_FILTER, LIST_FILTER_TYPE_SEARCH, REVISE_OPERATION_AFTER, REVISE_OPERATION_BEFORE, REVISE_OPERATION_BOTTOM, REVISE_OPERATION_TOP

Constructor Summary

Constructors

Constructor and 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

Modifier and Type	Method and Description
FirewallRule	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation) Adds a new firewall rule in existing firewall section.
void	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Adds a new firewall rule in existing firewall section.
void	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Adds a new firewall rule in existing firewall section.
FirewallRule	create(java.lang.String sectionId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Adds a new firewall rule in existing firewall section.
FirewallRuleList	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation) Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section.
void	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback) Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section.
void	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section.
FirewallRuleList	createmultiple(java.lang.String sectionId, FirewallRuleList firewallRuleList, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section.
void	delete(java.lang.String sectionId, java.lang.String ruleId) Delete existing firewall rule in a firewall section.
void	delete(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete existing firewall rule in a firewall section.
void	delete(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete existing firewall rule in a firewall section.
void	delete(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete existing firewall rule in a firewall section.
FirewallRule	get(java.lang.String sectionId, java.lang.String ruleId) Return existing firewall rule information in a firewall section.
void	get(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Return existing firewall rule information in a firewall section.
void	get(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return existing firewall rule information in a firewall section.
FirewallRule	get(java.lang.String sectionId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return existing firewall rule information in a firewall section.
FirewallRuleListResult	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources) Return all firewall rule(s) information for a given firewall section.
void	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback) Return all firewall rule(s) information for a given firewall section.
void	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return all firewall rule(s) information for a given firewall section.
FirewallRuleListResult	list(java.lang.String sectionId, java.lang.String appliedTos, java.lang.String contextProfiles, java.lang.String cursor, java.lang.Boolean deepSearch, java.lang.String destinations, java.lang.String extendedSources, java.lang.String filterType, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean searchInvalidReferences, java.lang.String services, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String sources, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return all firewall rule(s) information for a given firewall section.
FirewallRule	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation) Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section.
void	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section.
void	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section.
FirewallRule	revise(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, java.lang.String id, java.lang.String operation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section.
FirewallRule	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule) Modifies existing firewall rule in a firewall section.
void	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback) Modifies existing firewall rule in a firewall section.
void	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies existing firewall rule in a firewall section.
FirewallRule	update(java.lang.String sectionId, java.lang.String ruleId, FirewallRule firewallRule, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies existing firewall rule in a firewall section.

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

create

public FirewallRule create(java.lang.String sectionId,
                           FirewallRule firewallRule,
                           java.lang.String id,
                           java.lang.String operation)

Description copied from interface: Rules

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

Specified by:

create in interface Rules

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx.model.FirewallRule

create

public FirewallRule create(java.lang.String sectionId,
                           FirewallRule firewallRule,
                           java.lang.String id,
                           java.lang.String operation,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-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:

create in interface Rules

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

create

public void create(java.lang.String sectionId,
                   FirewallRule firewallRule,
                   java.lang.String id,
                   java.lang.String operation,
                   com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Description copied from interface: Rules

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

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

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

Specified by:

create in interface Rules

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

create

public void create(java.lang.String sectionId,
                   FirewallRule firewallRule,
                   java.lang.String id,
                   java.lang.String operation,
                   com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Adds a new firewall rule in existing firewall section. Adding firewall rule to a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale content to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-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.model.FirewallRule

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

Specified by:

create in interface Rules

Parameters:

sectionId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (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.

createmultiple

public FirewallRuleList createmultiple(java.lang.String sectionId,
                                       FirewallRuleList firewallRuleList,
                                       java.lang.String id,
                                       java.lang.String operation)

Description copied from interface: Rules

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

Specified by:

createmultiple in interface Rules

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx.model.FirewallRuleList

createmultiple

public FirewallRuleList createmultiple(java.lang.String sectionId,
                                       FirewallRuleList firewallRuleList,
                                       java.lang.String id,
                                       java.lang.String operation,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-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:

createmultiple in interface Rules

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRuleList

createmultiple

public void createmultiple(java.lang.String sectionId,
                           FirewallRuleList firewallRuleList,
                           java.lang.String id,
                           java.lang.String operation,
                           com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback)

Description copied from interface: Rules

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies/

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

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

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

Specified by:

createmultiple in interface Rules

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

createmultiple

public void createmultiple(java.lang.String sectionId,
                           FirewallRuleList firewallRuleList,
                           java.lang.String id,
                           java.lang.String operation,
                           com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleList> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Create multiple firewall rules in existing firewall section bounded by limit of 1000 firewall rules per section. Adding multiple firewall rules in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-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.model.FirewallRuleList

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

Specified by:

createmultiple in interface Rules

Parameters:

sectionId - (required)

firewallRuleList - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (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.

delete

public void delete(java.lang.String sectionId,
                   java.lang.String ruleId)

Description copied from interface: Rules

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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

Specified by:

delete in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

delete

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

Description copied from interface: Rules

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//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:

delete in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: Rules

Delete existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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:

sectionId - (required)

ruleId - (required)

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

delete

public void delete(java.lang.String sectionId,
                   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 existing firewall rule in a firewall section. Deleting firewall rule in a section modifies parent section and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
DELETE /policy/api/v1/infra/domains//security-policies//rules/

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:

sectionId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

get

public FirewallRule get(java.lang.String sectionId,
                        java.lang.String ruleId)

Description copied from interface: Rules

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules/

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

Specified by:

get in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

Returns:

com.vmware.nsx.model.FirewallRule

get

public FirewallRule get(java.lang.String sectionId,
                        java.lang.String ruleId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//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:

get in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

get

public void get(java.lang.String sectionId,
                java.lang.String ruleId,
                com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Description copied from interface: Rules

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules/

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

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

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:

sectionId - (required)

ruleId - (required)

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

get

public void get(java.lang.String sectionId,
                java.lang.String ruleId,
                com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Return existing firewall rule information in a firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//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.model.FirewallRule

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:

sectionId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public FirewallRuleListResult list(java.lang.String sectionId,
                                   java.lang.String appliedTos,
                                   java.lang.String contextProfiles,
                                   java.lang.String cursor,
                                   java.lang.Boolean deepSearch,
                                   java.lang.String destinations,
                                   java.lang.String extendedSources,
                                   java.lang.String filterType,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.Boolean searchInvalidReferences,
                                   java.lang.String services,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy,
                                   java.lang.String sources)

Description copied from interface: Rules

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies/

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

Specified by:

list in interface Rules

Parameters:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

Returns:

com.vmware.nsx.model.FirewallRuleListResult

list

public FirewallRuleListResult list(java.lang.String sectionId,
                                   java.lang.String appliedTos,
                                   java.lang.String contextProfiles,
                                   java.lang.String cursor,
                                   java.lang.Boolean deepSearch,
                                   java.lang.String destinations,
                                   java.lang.String extendedSources,
                                   java.lang.String filterType,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.Boolean searchInvalidReferences,
                                   java.lang.String services,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy,
                                   java.lang.String sources,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-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:

list in interface Rules

Parameters:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRuleListResult

list

public void list(java.lang.String sectionId,
                 java.lang.String appliedTos,
                 java.lang.String contextProfiles,
                 java.lang.String cursor,
                 java.lang.Boolean deepSearch,
                 java.lang.String destinations,
                 java.lang.String extendedSources,
                 java.lang.String filterType,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean searchInvalidReferences,
                 java.lang.String services,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String sources,
                 com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback)

Description copied from interface: Rules

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies/

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

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

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:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

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

list

public void list(java.lang.String sectionId,
                 java.lang.String appliedTos,
                 java.lang.String contextProfiles,
                 java.lang.String cursor,
                 java.lang.Boolean deepSearch,
                 java.lang.String destinations,
                 java.lang.String extendedSources,
                 java.lang.String filterType,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean searchInvalidReferences,
                 java.lang.String services,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String sources,
                 com.vmware.vapi.bindings.client.AsyncCallback<FirewallRuleListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Return all firewall rule(s) information for a given firewall section.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-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.model.FirewallRuleListResult

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:

sectionId - (required)

appliedTos - AppliedTo's referenced by this section or section's Distributed Service Rules . (optional)

contextProfiles - Limits results to sections having rules with specific Context Profiles. (optional)

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

deepSearch - Toggle to search with direct or indirect references. (optional, default to false)

destinations - Destinations referenced by this section's Distributed Service Rules . (optional)

extendedSources - Limits results to sections having rules with specific Extended Sources. (optional)

filterType - Filter type (optional, default to FILTER)

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)

searchInvalidReferences - Return invalid references in results. (optional, default to false)

services - NSService referenced by this section's Distributed Service Rules . (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

sources - Sources referenced by this section's Distributed Service Rules . (optional)

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

invocationConfig - Configuration for the method invocation.

revise

public FirewallRule revise(java.lang.String sectionId,
                           java.lang.String ruleId,
                           FirewallRule firewallRule,
                           java.lang.String id,
                           java.lang.String operation)

Description copied from interface: Rules

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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

Specified by:

revise in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

Returns:

com.vmware.nsx.model.FirewallRule

revise

public FirewallRule revise(java.lang.String sectionId,
                           java.lang.String ruleId,
                           FirewallRule firewallRule,
                           java.lang.String id,
                           java.lang.String operation,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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:

revise in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

revise

public void revise(java.lang.String sectionId,
                   java.lang.String ruleId,
                   FirewallRule firewallRule,
                   java.lang.String id,
                   java.lang.String operation,
                   com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Description copied from interface: Rules

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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

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

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

Specified by:

revise in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (optional)

operation - Operation (optional, default to insert_top)

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

revise

public void revise(java.lang.String sectionId,
                   java.lang.String ruleId,
                   FirewallRule firewallRule,
                   java.lang.String id,
                   java.lang.String operation,
                   com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Modifies existing firewall rule along with relative position among other firewall rules inside a firewall section. Revising firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
POST /policy/api/v1/infra/domains//security-policies//rules/?action=revise

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

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

Specified by:

revise in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

id - Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'. (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

public FirewallRule update(java.lang.String sectionId,
                           java.lang.String ruleId,
                           FirewallRule firewallRule)

Description copied from interface: Rules

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//rules/

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

Specified by:

update in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

Returns:

com.vmware.nsx.model.FirewallRule

update

public FirewallRule update(java.lang.String sectionId,
                           java.lang.String ruleId,
                           FirewallRule firewallRule,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//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:

update in interface Rules

Parameters:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallRule

update

public void update(java.lang.String sectionId,
                   java.lang.String ruleId,
                   FirewallRule firewallRule,
                   com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback)

Description copied from interface: Rules

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//rules/

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

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

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:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

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

update

public void update(java.lang.String sectionId,
                   java.lang.String ruleId,
                   FirewallRule firewallRule,
                   com.vmware.vapi.bindings.client.AsyncCallback<FirewallRule> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Modifies existing firewall rule in a firewall section. Updating firewall rule in a section modifies parent section entity and simultaneous update (modify) operations on same section are not allowed to prevent overwriting stale contents to firewall section. If a concurrent update is performed, HTTP response code 409 will be returned to the client operating on stale data. That client should retrieve the firewall section again and re-apply its update.

Use the following Policy API -
PUT|PATCH /policy/api/v1/infra/domains//security-policies//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.model.FirewallRule

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:

sectionId - (required)

ruleId - (required)

firewallRule - (required)

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

invocationConfig - Configuration for the method invocation.